ATSUGetAllAttributes

OSStatus ATSUGetAllAttributes (
                     ATSUStyle iStyle,
                     ATSUAttributeInfo oAttributeInfoArray[],
                     ItemCount iTagValuePairArraySize,
                     ItemCount *oTagValuePairCount);

iStyle

A reference of type ATSUStyle. Pass a reference to a valid style object whose style run attribute information you want to obtain. You cannot pass NULL for this parameter.

oAttributeInfoArray

An array of structures of type ATSUAttributeInfo. Before calling ATSUGetAllAttributes, pass a pointer to memory that you have allocated for this array. If you are uncertain of how much memory to allocate, see the discussion below. On return, the array contains the tag and data size pairs corresponding to all previously set style run attribute values in the style object.

iTagValuePairArraySize

The maximum number of tags and data sizes in the style object. Typically, this is equivalent to the number of ATSUAttributeInfo structures in the oAttributeInfoArray array. To determine this value, see the discussion below.

oTagValuePairCount

A pointer to a count. On return, the actual number of ATSUAttributeInfo structures in the style object. This may be greater than the value you specified in the iTagValuePairArraySize parameter. You cannot pass NULL for this parameter.

function result

A result code. See Result Codes.

DISCUSSION

The ATSUGetAllAttributes function obtains an array of the tags and data sizes corresponding to all previously set style run attributes in a style object. You can obtain a particular attribute value by passing the corresponding tag and data size pair to the function ATSUGetAttribute.

The best way to use ATSUGetAllAttributes is to call it twice:

Pass a reference to the style object containing the attribute in the iStyle parameter, NULL for the oAttributeInfoArray parameter, and 0 for the other parameters. ATSUGetAllAttributes returns the size of the tag and data size arrays in the oTagValuePairCount parameter.
Allocate enough space for an array of the returned size, then call the function again, passing a pointer in the oAttributeInfoArray parameter; on return, the pointer references the array of tag and data size pairs.

VERSION NOTES

Available beginning with ATSUI 1.0.